/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use
 * this file except in compliance with the License. You may obtain a copy of the License at the
 * following location:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>Unless required by applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apereo.portal.rest.search;

import java.util.List;
import javax.servlet.http.HttpServletRequest;

/**
 * Spring-managed beans that implement this interface provide search results to the {@link
 * SearchRESTController}. The controller detects all such beans and uses them.
 *
 * @since 5.0
 */
public interface ISearchStrategy {

    /** Indicates the type of objects in the result list, e.g. 'people' or 'portlets.' */
    String getResultTypeName();

    /** Provide strategy-specific results. */
    List<?> search(String query, HttpServletRequest request);
}
